DATACMNS-1190 - Added section on how to enforce nullability constraints on repositories #253
+99
−67
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ts on repositories. Original pull request: #253.
odrotbohm
force-pushed
the
issue/DATACMNS-1190
branch
from
5a449ba to
1f12660
Compare
mp911de
requested changes
Oct 10, 2017
src/main/asciidoc/repositories.adoc
Outdated
| The absence of a query result will then be indicated by returning `null`. | ||
| Repository methods returning collection like values will never return null but an empty value. | ||
|
|
||
| [[repositories.nullability.annotations]] |
There was a problem hiding this comment.
This section duplicates the section on Null-safety that is currently in place. It would make sense to move core.nullability-validation in here.
There was a problem hiding this comment.
After revisiting the other version of the docs, I'd actually like to keep this one here and augment it with the following aspects currently present in the other version:
- Nullability annotations should list the fully-qualified name at least once, so that it's clear what to import. I think we can (should?) leave out the remark with JSR-305 needed for meta-annotation usage. That's taking it a bit too far I think.
- The
kotlin-reflectlibrary needed to get the runtime checks enabled.
src/main/asciidoc/repositories.adoc
Outdated
|
|
||
| Alternatively query methods can choose not to use a wrapper type at all. | ||
| The absence of a query result will then be indicated by returning `null`. | ||
| Repository methods returning collection like values will never return null but an empty value. |
There was a problem hiding this comment.
How about Repository methods returning collections, wrappers, and streams are guaranteed to never return null but rather the corresponding empty representation.?
There was a problem hiding this comment.
Maybe we should link to the appendix table listing all supported return types as they also list the alternative collection types we support that might be handy to know about but don't need any discussion here.
odrotbohm
commented
Oct 10, 2017
src/main/asciidoc/repositories.adoc
Outdated
| ==== Nullability in Kotlin-based repositories | ||
|
|
||
| Kotlin has the definition of nullability constraints baked into the language. | ||
| Spring Data repositories using the language mechanism to define those constraints will automatically get the same runtime checks applied: |
There was a problem hiding this comment.
Probably a good place to mention the need to have kotlin-reflect on the classpath.
Remove existing section on Null-safety. Augment Null handling section with bits of the previous documentation, explicitly describe annotations expressing null-constraints, include full-qualified imports, mention kotlin-reflect dependency for Kotlin metadata introspection. Align callouts, add links, slightly improve wording, typos. Extend year range in copyright header.
mp911de
force-pushed
the
issue/DATACMNS-1190
branch
from
d7bfa82 to
fe4a09d
Compare
mp911de
approved these changes
Oct 11, 2017
odrotbohm
added a commit
that referenced
this pull request
Oct 11, 2017
…ts on repositories. Original pull request: #253.
odrotbohm
pushed a commit
that referenced
this pull request
Oct 11, 2017
Remove existing section on Null-safety. Augment Null handling section with bits of the previous documentation, explicitly describe annotations expressing null-constraints, include full-qualified imports, mention kotlin-reflect dependency for Kotlin metadata introspection. Align callouts, add links, slightly improve wording, typos. Extend year range in copyright header. Original pull request: #253.
odrotbohm
added a commit
that referenced
this pull request
Oct 11, 2017
Slight rewording. Extracted path to Spring Framework JavaDoc into variable. Original pull request: #253.
odrotbohm
added a commit
that referenced
this pull request
Oct 11, 2017
Slight rewording. Extracted path to Spring Framework JavaDoc into variable. Original pull request: #253.
odrotbohm
added a commit
that referenced
this pull request
Oct 11, 2017
Slight rewording. Extracted path to Spring Framework JavaDoc into variable. Original pull request: #253.
odrotbohm
added a commit
that referenced
this pull request
Oct 11, 2017
…ts on repositories. Original pull request: #253.
odrotbohm
pushed a commit
that referenced
this pull request
Oct 11, 2017
Remove existing section on Null-safety. Augment Null handling section with bits of the previous documentation, explicitly describe annotations expressing null-constraints, include full-qualified imports, mention kotlin-reflect dependency for Kotlin metadata introspection. Align callouts, add links, slightly improve wording, typos. Extend year range in copyright header. Original pull request: #253.
odrotbohm
added a commit
that referenced
this pull request
Oct 11, 2017
Slight rewording. Extracted path to Spring Framework JavaDoc into variable. Original pull request: #253.
Aloren
pushed a commit
to Aloren/spring-data-commons
that referenced
this pull request
Jun 20, 2019
Aloren
pushed a commit
to Aloren/spring-data-commons
that referenced
this pull request
Jun 20, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.